-
Notifications
You must be signed in to change notification settings - Fork 903
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add load node line magic documentation #3619
Conversation
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]> Signed-off-by: L. R. Couto <[email protected]>
Co-authored-by: Ahdra Merali <[email protected]> Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if it's covered already. I think we need to mention how to find the node_name. i.e. read from the kedro's run log if it's defined already, or go to the node definition, add a node name if needed. I think this is shown in the GIF somehow but we should give clear instruction.
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
|
||
</details> | ||
|
||
2. In your notebook, run `%load_node <name-of-failing-node>` to load the contents of the problematic node with the [`%load_node` line magic](#kedro-line-magics). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting on the %load_node
line magic subheading was causing issues with Sphinx when referenced. Instead, I've linked to the line magic section as a whole.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Description
Addresses #2011
Also addresses #2777
This page of the docs required several levels of changes, which have been addressed in this PR:
%load_ext kedro.ipython
to make it more visible #2777 @ankatiyarDevelopment notes
Ignore all the early commits - this branch was created before the earlier debugging docs changes were merged into main
%load_node line magic
Re: Rejigging the page - the following were considered:
kedro jupyter notebook" but is contextualised by the images provided, and as such I don't expect the terms to be as confusing. The following section "What does
kedro jupyter notebook` do?" also makes references to the kernel established the in the section above it. Once again, as the use is contextualised, I don't expect the term to be as jarring.Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-by
line in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.md
file